/*
 * Copyright 2010-2012 Susanta Tewari. <freecode4susant@users.sourceforge.net>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package bd.org.apache.commons.math.exception;

import bd.org.apache.commons.math.exception.util.ExceptionContext;
import bd.org.apache.commons.math.exception.util.ExceptionContextProvider;
import bd.org.apache.commons.math.exception.util.Localizable;

/**
 * Base class for all preconditions violation exceptions.
 * In most cases, this class should not be instantiated directly: it should
 * serve as a base class to create all the exceptions that have the semantics
 * of the standard {@link IllegalArgumentException}.
 *
 * @version $Id$
 * @since 2.2
 */
public class MathIllegalArgumentException extends IllegalArgumentException
        implements ExceptionContextProvider {

    /**
     * Serializable version Id.
     */
    private static final long serialVersionUID = -6024911025449780478L;

    /**
     * Context.
     */
    private final ExceptionContext context;

    /**
     * @param pattern Message pattern explaining the cause of the error.
     * @param args Arguments.
     */
    public MathIllegalArgumentException(Localizable pattern, Object... args) {

        context = new ExceptionContext(this);

        context.addMessage(pattern, args);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public ExceptionContext getContext() {

        return context;
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public String getMessage() {

        return context.getMessage();
    }


    /**
     * {@inheritDoc}
     */
    @Override
    public String getLocalizedMessage() {

        return context.getLocalizedMessage();
    }
}
